Vcenter Vcha Cluster DeploySpec

Vcenter Vcha Cluster DeploySpec
Vcenter Vcha Cluster DeploySpec

The Vcenter Vcha Cluster DeploySpec schema contains the deploy specification for the three nodes of a VCHA cluster.

This schema was added in vSphere API 6.7.1.

JSON Example
{
    "vc_spec": {
        "active_location": {
            "hostname": "string",
            "port": 0,
            "ssl_thumbprint": "string",
            "ssl_certificate": "string",
            "username": "string",
            "password": "string"
        }
    },
    "deployment": "string",
    "active": {
        "ha_network_type": "string",
        "ha_network": "string",
        "ha_ip": {
            "ip_family": "string",
            "ipv4": {
                "address": "string",
                "subnet_mask": "string",
                "prefix": 0
            },
            "ipv6": {
                "address": "string",
                "prefix": 0
            },
            "default_gateway": "string",
            "dns_servers": [
                "string"
            ]
        }
    },
    "passive": {
        "placement": {
            "name": "string",
            "folder": "string",
            "host": "string",
            "resource_pool": "string",
            "ha_network_type": "string",
            "ha_network": "string",
            "management_network_type": "string",
            "management_network": "string",
            "storage": {
                "datastore": "string"
            }
        },
        "ha_ip": {
            "ip_family": "string",
            "ipv4": {
                "address": "string",
                "subnet_mask": "string",
                "prefix": 0
            },
            "ipv6": {
                "address": "string",
                "prefix": 0
            },
            "default_gateway": "string",
            "dns_servers": [
                "string"
            ]
        },
        "failover_ip": {
            "ip_family": "string",
            "ipv4": {
                "address": "string",
                "subnet_mask": "string",
                "prefix": 0
            },
            "ipv6": {
                "address": "string",
                "prefix": 0
            },
            "default_gateway": "string",
            "dns_servers": [
                "string"
            ]
        }
    },
    "witness": {
        "placement": {
            "name": "string",
            "folder": "string",
            "host": "string",
            "resource_pool": "string",
            "ha_network_type": "string",
            "ha_network": "string",
            "management_network_type": "string",
            "management_network": "string",
            "storage": {
                "datastore": "string"
            }
        },
        "ha_ip": {
            "ip_family": "string",
            "ipv4": {
                "address": "string",
                "subnet_mask": "string",
                "prefix": 0
            },
            "ipv6": {
                "address": "string",
                "prefix": 0
            },
            "default_gateway": "string",
            "dns_servers": [
                "string"
            ]
        }
    }
}
vc_spec
Optional

Contains the active node's management vCenter server credentials.

This property was added in vSphere API 6.7.1.

If missing or null, then the active vCenter Server instance is assumed to be either self-managed or else in enhanced linked mode and managed by a linked vCenter Server instance.

string
deployment
Required

Contains the deployment type.

For more information see: Vcenter Vcha Cluster Type.

This property was added in vSphere API 6.7.1.

active
Required

Contains the active node's network configuration.

This property was added in vSphere API 6.7.1.

passive
Required

Contains the passive node's placement configuration.

This property was added in vSphere API 6.7.1.

witness
Required

Contains the witness node's placement configuration.

This property was added in vSphere API 6.7.1.

Parameter To